API

Human resource APIs

GET human-resources/employees/{employeeId}/bookmarks/{bookmarkId}

Get details about a specific bookmark

HTTP method GET
URI https://api.rambase.net/human-resources/employees/{employeeId}/bookmarks/{bookmarkId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {employeeId} Employee identifier
Integer, minimum 100
- URI parameter {bookmarkId} A unique identifier for a RamBase Bookmark Item
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 1795, version 2

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Bookmark>
2
     <BookmarkId
BookmarkId

A unique identifier for a RamBase Bookmark Item

>{Integer}</BookmarkId>
3
     <ObjectStatus
ObjectStatus

The status of the RamBase Bookmark. The following values will be legal: 1 - Edit state, 4 - Active State, 9 - Discontinued state. For a bookmark to show up in the bookmark menu it has to be in status 4.

>{Integer}</ObjectStatus>
4
     <Title
Title

The title of the Bookmark. This is the title/text that will be displayed in the bookmark menu tree.

>{String}</Title>
5
     <TranslatedTitle
TranslatedTitle

This is the same as the title field, except from the title being translated into the current user preffered language. If a translation in that language does not exist, the english title will be returned.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedTitle in your request URI to get this field

>{String}</TranslatedTitle>
6
     <Url
Url

The URL we will navigate to when clicking a bookmark. This can be either a relative or an absolute URL.

>{String}</Url>
7
     <IconName
IconName

Each bookmark can have an icon associated with it. If your RamBase Menu Item should have an icon this field must contain the name of an icon that exists in the RamBase icon set.

>{String}</IconName>
8
     <OrderIndex
OrderIndex

The order of bookmarks are controlled by this index field. A lower number will mean a higher rank in the menu. Index 0 will be on the top of the menu.

>{Integer}</OrderIndex>
9
     <TreeLevel
TreeLevel

The level at which this bookmark exist in the tree. Level 0 will mean that it is a root level node.

>{Integer}</TreeLevel>
10
     <HasSubmenuBookmarks
HasSubmenuBookmarks

Indicates if this bookmark has any sub menu bookmarks connected to it.

>{Boolean}</HasSubmenuBookmarks>
11
     <ParentBookmark>
12
          <ParentBookmarkId
ParentBookmarkId

A reference to the parent bookmark id. Will contain the BookmarkId of the parent bookmark.

>{Integer}</ParentBookmarkId>
13
          <ParentBookmarkLink
ParentBookmarkLink

An parent object reference. Will link to the parent bookmark

>{String}</ParentBookmarkLink>
14
     </ParentBookmark>
15
     <RootBookmark>
16
          <RootBookmarkId
RootBookmarkId

A reference to the root bookmark item (the root of the tree). Will contain the BookmarkId of the bookmark at the root of the tree.

>{Integer}</RootBookmarkId>
17
          <RootBookmarkLink
RootBookmarkLink

A root object reference. Will link to the bookmark at the root of the tree.

>{String}</RootBookmarkLink>
18
     </RootBookmark>
19
</Bookmark>
1
{
2
     "bookmark": {
3
          "bookmarkId
BookmarkId

A unique identifier for a RamBase Bookmark Item

": "{Integer}",
4
          "objectStatus
ObjectStatus

The status of the RamBase Bookmark. The following values will be legal: 1 - Edit state, 4 - Active State, 9 - Discontinued state. For a bookmark to show up in the bookmark menu it has to be in status 4.

": "{Integer}",
5
          "title
Title

The title of the Bookmark. This is the title/text that will be displayed in the bookmark menu tree.

": "{String}",
6
          "translatedTitle
TranslatedTitle

This is the same as the title field, except from the title being translated into the current user preffered language. If a translation in that language does not exist, the english title will be returned.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedTitle in your request URI to get this field

": "{String}",
7
          "url
Url

The URL we will navigate to when clicking a bookmark. This can be either a relative or an absolute URL.

": "{String}",
8
          "iconName
IconName

Each bookmark can have an icon associated with it. If your RamBase Menu Item should have an icon this field must contain the name of an icon that exists in the RamBase icon set.

": "{String}",
9
          "orderIndex
OrderIndex

The order of bookmarks are controlled by this index field. A lower number will mean a higher rank in the menu. Index 0 will be on the top of the menu.

": "{Integer}",
10
          "treeLevel
TreeLevel

The level at which this bookmark exist in the tree. Level 0 will mean that it is a root level node.

": "{Integer}",
11
          "hasSubmenuBookmarks
HasSubmenuBookmarks

Indicates if this bookmark has any sub menu bookmarks connected to it.

": "{Boolean}",
12
          "parentBookmark": {
13
               "parentBookmarkId
ParentBookmarkId

A reference to the parent bookmark id. Will contain the BookmarkId of the parent bookmark.

": "{Integer}",
14
               "parentBookmarkLink
ParentBookmarkLink

An parent object reference. Will link to the parent bookmark

": "{String}"
15
          },
16
          "rootBookmark": {
17
               "rootBookmarkId
RootBookmarkId

A reference to the root bookmark item (the root of the tree). Will contain the BookmarkId of the bookmark at the root of the tree.

": "{Integer}",
18
               "rootBookmarkLink
RootBookmarkLink

A root object reference. Will link to the bookmark at the root of the tree.

": "{String}"
19
          }
20
     }
21
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100443 HTTP 404 {0} is missing or invalid
Error 100659 HTTP 404 Bookmark not found